<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Status Masks</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__sar2__macros__status.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">Status Masks<div class="ingroups"><a class="el" href="group__group__sar2.html">SAR2         (Analog to Digital Converter (ADC))</a> &raquo; <a class="el" href="group__group__sar2__macro.html">Macros</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gabd7c90dbbcbdf723ac3d933620bcf3f1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar2__macros__status.html#gabd7c90dbbcbdf723ac3d933620bcf3f1">CY_SAR2_STATUS_ABOVE</a>&#160;&#160;&#160;(PASS_SAR_CH_RESULT_ABOVE_HI_MIR_Msk)</td></tr>
<tr class="memdesc:gabd7c90dbbcbdf723ac3d933620bcf3f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">If this bit is true, "out of range" was detected and the value was above the High threshold.  <a href="#gabd7c90dbbcbdf723ac3d933620bcf3f1">More...</a><br /></td></tr>
<tr class="separator:gabd7c90dbbcbdf723ac3d933620bcf3f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaebe4e47a297767ae21d906926163918f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar2__macros__status.html#gaebe4e47a297767ae21d906926163918f">CY_SAR2_STATUS_RANGE</a>&#160;&#160;&#160;(PASS_SAR_CH_RESULT_RANGE_INTR_MIR_Msk)</td></tr>
<tr class="memdesc:gaebe4e47a297767ae21d906926163918f"><td class="mdescLeft">&#160;</td><td class="mdescRight">If this bit is true, the range is detected.  <a href="#gaebe4e47a297767ae21d906926163918f">More...</a><br /></td></tr>
<tr class="separator:gaebe4e47a297767ae21d906926163918f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga39e7ebedc01b84e1046cb4e762da13e0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar2__macros__status.html#ga39e7ebedc01b84e1046cb4e762da13e0">CY_SAR2_STATUS_PULSE</a>&#160;&#160;&#160;(PASS_SAR_CH_RESULT_PULSE_INTR_MIR_Msk)</td></tr>
<tr class="memdesc:ga39e7ebedc01b84e1046cb4e762da13e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">If this bit is true, the pulse is detected.  <a href="#ga39e7ebedc01b84e1046cb4e762da13e0">More...</a><br /></td></tr>
<tr class="separator:ga39e7ebedc01b84e1046cb4e762da13e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6cbb872bbf250c92401e8fdec7bc25a8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar2__macros__status.html#ga6cbb872bbf250c92401e8fdec7bc25a8">CY_SAR2_STATUS_VALID</a>&#160;&#160;&#160;(PASS_SAR_CH_RESULT_VALID_MIR_Msk)</td></tr>
<tr class="memdesc:ga6cbb872bbf250c92401e8fdec7bc25a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">If this bit is true, the result data is valid.  <a href="#ga6cbb872bbf250c92401e8fdec7bc25a8">More...</a><br /></td></tr>
<tr class="separator:ga6cbb872bbf250c92401e8fdec7bc25a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4b141d40c002bc53a91913b0096daf8a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar2__macros__status.html#ga4b141d40c002bc53a91913b0096daf8a">CY_SAR2_GRP_COMPLETE</a>&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_GRP_COMPLETE_Msk)</td></tr>
<tr class="memdesc:ga4b141d40c002bc53a91913b0096daf8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Group acquisition completed.  <a href="#ga4b141d40c002bc53a91913b0096daf8a">More...</a><br /></td></tr>
<tr class="separator:ga4b141d40c002bc53a91913b0096daf8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6047991580fc1398df98cdca6e001119"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar2__macros__status.html#ga6047991580fc1398df98cdca6e001119">CY_SAR2_GRP_CANCELLED</a>&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_GRP_CANCELLED_Msk)</td></tr>
<tr class="memdesc:ga6047991580fc1398df98cdca6e001119"><td class="mdescLeft">&#160;</td><td class="mdescRight">Group Cancelled.  <a href="#ga6047991580fc1398df98cdca6e001119">More...</a><br /></td></tr>
<tr class="separator:ga6047991580fc1398df98cdca6e001119"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacf9eea922d195526391b456b90047831"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar2__macros__status.html#gacf9eea922d195526391b456b90047831">CY_SAR2_GRP_OVERFLOW</a>&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_GRP_OVERFLOW_Msk)</td></tr>
<tr class="memdesc:gacf9eea922d195526391b456b90047831"><td class="mdescLeft">&#160;</td><td class="mdescRight">Group Overflow.  <a href="#gacf9eea922d195526391b456b90047831">More...</a><br /></td></tr>
<tr class="separator:gacf9eea922d195526391b456b90047831"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga430492590e66270eca0aa2ae052763e4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar2__macros__status.html#ga430492590e66270eca0aa2ae052763e4">CY_SAR2_CH_RANGE_COMPLETE</a>&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_CH_RANGE_COMPLETE_Msk)</td></tr>
<tr class="memdesc:ga430492590e66270eca0aa2ae052763e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Channel Range completed.  <a href="#ga430492590e66270eca0aa2ae052763e4">More...</a><br /></td></tr>
<tr class="separator:ga430492590e66270eca0aa2ae052763e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0dea96024824ecce8052d3fdd5df0bd7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar2__macros__status.html#ga0dea96024824ecce8052d3fdd5df0bd7">CY_SAR2_CH_PULSE_COMPLETE</a>&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_CH_PULSE_COMPLETE_Msk)</td></tr>
<tr class="memdesc:ga0dea96024824ecce8052d3fdd5df0bd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Channel Pulse completed.  <a href="#ga0dea96024824ecce8052d3fdd5df0bd7">More...</a><br /></td></tr>
<tr class="separator:ga0dea96024824ecce8052d3fdd5df0bd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga09cbcc1c9d0be779f7676e8586e5654f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar2__macros__status.html#ga09cbcc1c9d0be779f7676e8586e5654f">CY_SAR2_CH_OVERFLOW</a>&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_CH_OVERFLOW_Msk)</td></tr>
<tr class="memdesc:ga09cbcc1c9d0be779f7676e8586e5654f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Channel Overflow.  <a href="#ga09cbcc1c9d0be779f7676e8586e5654f">More...</a><br /></td></tr>
<tr class="separator:ga09cbcc1c9d0be779f7676e8586e5654f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7016669be33eaf1b5314d311ff686b5a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sar2__macros__status.html#ga7016669be33eaf1b5314d311ff686b5a">CY_SAR2_GRP_BUSY</a>&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_GRP_BUSY_Msk)</td></tr>
<tr class="memdesc:ga7016669be33eaf1b5314d311ff686b5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Group acquisition busy.  <a href="#ga7016669be33eaf1b5314d311ff686b5a">More...</a><br /></td></tr>
<tr class="separator:ga7016669be33eaf1b5314d311ff686b5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gabd7c90dbbcbdf723ac3d933620bcf3f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabd7c90dbbcbdf723ac3d933620bcf3f1">&#9670;&nbsp;</a></span>CY_SAR2_STATUS_ABOVE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SAR2_STATUS_ABOVE&#160;&#160;&#160;(PASS_SAR_CH_RESULT_ABOVE_HI_MIR_Msk)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If this bit is true, "out of range" was detected and the value was above the High threshold. </p>

</div>
</div>
<a id="gaebe4e47a297767ae21d906926163918f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaebe4e47a297767ae21d906926163918f">&#9670;&nbsp;</a></span>CY_SAR2_STATUS_RANGE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SAR2_STATUS_RANGE&#160;&#160;&#160;(PASS_SAR_CH_RESULT_RANGE_INTR_MIR_Msk)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If this bit is true, the range is detected. </p>

</div>
</div>
<a id="ga39e7ebedc01b84e1046cb4e762da13e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga39e7ebedc01b84e1046cb4e762da13e0">&#9670;&nbsp;</a></span>CY_SAR2_STATUS_PULSE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SAR2_STATUS_PULSE&#160;&#160;&#160;(PASS_SAR_CH_RESULT_PULSE_INTR_MIR_Msk)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If this bit is true, the pulse is detected. </p>

</div>
</div>
<a id="ga6cbb872bbf250c92401e8fdec7bc25a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6cbb872bbf250c92401e8fdec7bc25a8">&#9670;&nbsp;</a></span>CY_SAR2_STATUS_VALID</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SAR2_STATUS_VALID&#160;&#160;&#160;(PASS_SAR_CH_RESULT_VALID_MIR_Msk)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If this bit is true, the result data is valid. </p>

</div>
</div>
<a id="ga4b141d40c002bc53a91913b0096daf8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4b141d40c002bc53a91913b0096daf8a">&#9670;&nbsp;</a></span>CY_SAR2_GRP_COMPLETE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SAR2_GRP_COMPLETE&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_GRP_COMPLETE_Msk)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Group acquisition completed. </p>
<p>This bit can be set for the last channel of a group if the group scan is done. </p>

</div>
</div>
<a id="ga6047991580fc1398df98cdca6e001119"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6047991580fc1398df98cdca6e001119">&#9670;&nbsp;</a></span>CY_SAR2_GRP_CANCELLED</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SAR2_GRP_CANCELLED&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_GRP_CANCELLED_Msk)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Group Cancelled. </p>
<p>This bit can be set for the last channel of a group if the group scan was preempted and cancelled. </p>

</div>
</div>
<a id="gacf9eea922d195526391b456b90047831"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacf9eea922d195526391b456b90047831">&#9670;&nbsp;</a></span>CY_SAR2_GRP_OVERFLOW</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SAR2_GRP_OVERFLOW&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_GRP_OVERFLOW_Msk)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Group Overflow. </p>
<p>This bit can be set for the last channel of a group if the group scan is done and the Done interrupt is already (still) pending. </p>

</div>
</div>
<a id="ga430492590e66270eca0aa2ae052763e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga430492590e66270eca0aa2ae052763e4">&#9670;&nbsp;</a></span>CY_SAR2_CH_RANGE_COMPLETE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SAR2_CH_RANGE_COMPLETE&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_CH_RANGE_COMPLETE_Msk)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Channel Range completed. </p>
<p>This bit can be set for each channel if the conversion result (after averaging) of that channel met the condition specified by the range detection mode settings of the channel. </p>

</div>
</div>
<a id="ga0dea96024824ecce8052d3fdd5df0bd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0dea96024824ecce8052d3fdd5df0bd7">&#9670;&nbsp;</a></span>CY_SAR2_CH_PULSE_COMPLETE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SAR2_CH_PULSE_COMPLETE&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_CH_PULSE_COMPLETE_Msk)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Channel Pulse completed. </p>
<p>This bit can be set for each channel if the positive pulse counter reaches zero. </p>

</div>
</div>
<a id="ga09cbcc1c9d0be779f7676e8586e5654f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga09cbcc1c9d0be779f7676e8586e5654f">&#9670;&nbsp;</a></span>CY_SAR2_CH_OVERFLOW</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SAR2_CH_OVERFLOW&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_CH_OVERFLOW_Msk)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Channel Overflow. </p>
<p>This bit can be set for each channel if a new Pulse or Range interrupt is detected while the interrupt is still pending or when HW did not acknowledge data pickup. </p>

</div>
</div>
<a id="ga7016669be33eaf1b5314d311ff686b5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7016669be33eaf1b5314d311ff686b5a">&#9670;&nbsp;</a></span>CY_SAR2_GRP_BUSY</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SAR2_GRP_BUSY&#160;&#160;&#160;(PASS_SAR_CH_GRP_STAT_GRP_BUSY_Msk)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Group acquisition busy. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
